Skip to main content

Get-IMPlugin

SYNOPSIS​

Retrieves Immich plugins

SYNTAX​

list (Default)​

Get-IMPlugin [-Session <ImmichSession>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

id​

Get-IMPlugin [-Session <ImmichSession>] -Id <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Retrieves one or more plugins from the Immich server. Can retrieve all plugins or a specific plugin by ID. Note: Plugin functionality is in Alpha state as of Immich v2.3.1.

EXAMPLES​

EXAMPLE 1​

Get-IMPlugin

Retrieves all plugins available to the current user.

EXAMPLE 2​

Get-IMPlugin -Id 'bde7ceba-f301-4e9e-87a2-163937a2a3db'

Retrieves a specific plugin by its ID.

EXAMPLE 3​

'plugin1-uuid', 'plugin2-uuid' | Get-IMPlugin

Retrieves multiple plugins by piping their IDs.

PARAMETERS​

-Session​

Optionally define an Immich session object to use. This is useful when you are connected to more than one Immich instance.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id​

The UUID of a specific plugin to retrieve. Accepts pipeline input.

Type: String
Parameter Sets: id
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

This feature is in Alpha state and may be subject to changes in future Immich versions.

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github